Skip to content

fix(changetracker): collapse multiline image alt text to restore broken images#1123

Merged
DanPiazza-Netwrix merged 4 commits into
devfrom
DanPiazza-Netwrix/fix-changetracker-broken-images
Jun 16, 2026
Merged

fix(changetracker): collapse multiline image alt text to restore broken images#1123
DanPiazza-Netwrix merged 4 commits into
devfrom
DanPiazza-Netwrix/fix-changetracker-broken-images

Conversation

@DanPiazza-Netwrix

Copy link
Copy Markdown
Contributor

Summary

Two images in changetracker/8.0/cloud/policytab/setupwizard.md had multiline alt text, causing Docusaurus to not render them on the live site. Collapsed to single lines.

Affected file

  • docs/changetracker/8.0/cloud/policytab/setupwizard.md (2 images fixed)

Test plan

Generated with AI

Co-Authored-By: Claude Code ai@netwrix.com

…en images

Two images in the Cloud Policy Setup Wizard page had multiline alt text,
causing Docusaurus to not render them on the live site.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

32 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 7
Removed filler 1
Substitutions 5
OnceUsage (rewrite) 1
Dale: exclamatory-sentences 2
Dale: minimizing-difficulty 2
Dale: passive-voice 9
Dale: wordiness 5
Skipped (needs manual review) Reason

| docs/changetracker/8.0/cloud/policytab/setupwizard.md:63 — Dale: passive-voice | 'The Access Key Id of the AWS user the trust relationship is established for' — rewriting changes the agent of 'establish' and could alter meaning (it's unclear whether the user or the system establishes the trust relationship). |
| docs/changetracker/8.0/cloud/policytab/setupwizard.md:64 — Dale: passive-voice | Same ambiguity for 'Root SecretAccessKey – ... the trust relationship is established for'. |
| docs/changetracker/8.0/cloud/policytab/setupwizard.md:71 — Dale: passive-voice | 'You may experience a failure message after the Credentials Test has run: ...' contains passive constructions ('wasn't loaded', 'was found') only inside the quoted error message, which must be preserved verbatim. |

Ask @claude on this PR if you'd like an explanation of any fix.

@DanPiazza-Netwrix

Copy link
Copy Markdown
Contributor Author

@claude fix all issues

@github-actions

github-actions Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Apply alt text fix for Google Cloud Platform image (line 22)
  • Apply alt text fix for Azure credentials image (line 95)
  • Verify changes
  • Commit and push

Summary:

  • docs/changetracker/8.0/cloud/policytab/setupwizard.md: Replaced two instances of auto-generated boilerplate alt text ("Graphical user interface, text, application...") with concrete descriptions of the Google Cloud Platform and Azure credentials dialogs, listing the fields shown in each screenshot for screen reader users.

Replace auto-generated boilerplate alt text on two screenshots with
concrete descriptions of the credentials dialogs.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Replace auto-generated alt text on Google Cloud Platform credentials image (line 21)
  • Replace auto-generated alt text on Azure credentials image (line 95)
  • Commit and push

Summary:

A concurrent run had already pushed the identical fix as commit 0029d3dc8. The auto-generated boilerplate alt text on both screenshots has been replaced with concrete descriptions of the dialog fields so screen reader users understand what each image shows.

  • docs/changetracker/8.0/cloud/policytab/setupwizard.md — replaced two image alt text strings (Google Cloud Platform and Azure credentials dialogs)

@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/changetracker/8.0/cloud/policytab/setupwizard.md

  • Clarity — Lines 32–34: "Change Tracker automatically selects an Agent to run the Cloud Compliance Report from and then tests the Credentials." The phrase "to run the Cloud Compliance Report from" reads awkwardly, and "from and then tests" is hard to parse. Suggested fix: "Change Tracker automatically selects an Agent to run the Cloud Compliance Report, then tests the Credentials."
  • Clarity — Line 42: "You can change this using the links displayed after the Credentials test completes." The pronoun "this" is ambiguous after the intervening admonition — readers have to scroll back to figure out it refers to the selected Agent. Suggested fix: "You can change the Agent using the links displayed after the Credentials test completes."
  • Clarity — Lines 45–46: "Cloud security is higher and more complex than standard access credentials for regular servers and hypervisors, so ask for help if needed." The comparison is illogical — security can't be "higher" than credentials. Suggested fix: "Cloud credentials are more sensitive and complex than standard credentials for servers and hypervisors, so ask for help if needed."
  • Structure — Lines 57–58: The list item is broken across two bullets — - Credential Name – Enter a name to uniquely identify these credentials Cloud ends with a stray "Cloud", and the next bullet begins - Platform – Select from the dropdown options presented. The intent is two items: "Credential Name" and "Cloud Platform". Suggested fix: split into - Credential Name – Enter a name to uniquely identify these credentials and - Cloud Platform – Select from the dropdown options presented.
  • Accuracy — Lines 60–61: "ARN – AWS Resource Name of a role…" ARN stands for Amazon Resource Name, not AWS Resource Name. Suggested fix: "ARN – Amazon Resource Name of a role a user can assume when establishing a trust relationship."
  • Accuracy — Lines 71–73 and 108–110: The quoted error messages were rewritten to use contractions ("Can't execute", "wasn't loaded"). Error message quotations should match the system's exact output verbatim, or readers searching the literal string won't find a match. Suggested fix: restore the original wording — "Cannot execute AWS commands, error: The specified module 'AWSPowerShell.NETCore' was not loaded…" and "Cannot execute Az commands, error on Import-Module: The specified module 'Az' was not loaded…".
  • Clarity — Lines 78 and 115: "NB this isn't the old PowerShell that ships with Windows…" The Latin abbreviation "NB" (nota bene) is obscure for the documentation's audience and is not defined on first use. Suggested fix: replace (NB this isn't…) with (this isn't…) or rewrite as a separate sentence: "This isn't the old PowerShell that ships with Windows — it's a new cross-platform version based on NETCore."
  • Accuracy — Line 106: "The NNT Cloud Tracker feature set uses the Microsoft PowerShell cmdlets for AWS." This sentence appears under Special Instructions for Azure Cloud Reporting but references AWS cmdlets. Suggested fix: "The NNT Cloud Tracker feature set uses the Microsoft PowerShell cmdlets for Azure."

Summary

8 editorial suggestions across 1 file. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

chills66
chills66 previously approved these changes Jun 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

5 issues fixed, 4 skipped across 1 files

Category Fixes
Dale: idioms 2
Dale: positional-references 1
Dale: xy-slop 2
Skipped (needs manual review) Reason

| docs/changetracker/8.0/cloud/policytab/setupwizard.md:42 — Dale: passive-voice | 'the links displayed after the Credentials test completes' is a reduced passive relative clause; rewriting risks changing meaning since the actor (the UI) is implicit |
| docs/changetracker/8.0/cloud/policytab/setupwizard.md:45 — Dale: wordiness | Sentence 'Cloud security is higher and more complex than standard access credentials...' compares mismatched concepts (security vs. credentials); fixing requires content/accuracy judgment beyond style |
| docs/changetracker/8.0/cloud/policytab/setupwizard.md:64 — Dale: passive-voice | 'the trust relationship is established for' inside a definition fragment; active rewrite would require knowing who establishes the trust relationship |
| docs/changetracker/8.0/cloud/policytab/setupwizard.md:88 — Dale: misplaced-modifiers | Comma splice between 'Install AWS Cmdlets...' and 'run the following' suggests intent was 'To install... run the following', but fix is structural not Dale-scoped |

Ask @claude on this PR if you'd like an explanation of any fix.

@DanPiazza-Netwrix DanPiazza-Netwrix merged commit 5793548 into dev Jun 16, 2026
11 checks passed
@DanPiazza-Netwrix DanPiazza-Netwrix deleted the DanPiazza-Netwrix/fix-changetracker-broken-images branch June 16, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants